KanziView Class Reference

A view that owns the native Kanzi application and provides the output surface. More...

Inheritance diagram for KanziView:

Classes
enum	State
	KanziView java-side lifecycle state. More...

Public Member Functions
	KanziView (Context context)
	Simple constructor to use when creating a KanziView from code.
	KanziView (Context context, AttributeSet attrs)
	Constructor that is called when inflating a KanziView from XML.
void	createNativeApplication ()
	Lifecycle handler for Lifecycle.Event.ON_CREATE events.
void	destroyNativeApplication ()
	Lifecycle handler for Lifecycle.Event.ON_DESTROY events.
boolean	onKeyDown (final int keyCode, KeyEvent event)
	A key down handler.
boolean	onKeyUp (final int keyCode, KeyEvent event)
	A key up handler.
boolean	onTouchEvent (final MotionEvent event)
	Handler for touches inside KanziView.
void	pauseNativeApplication ()
	Lifecycle handler for Lifecycle.Event.ON_PAUSE events.
int	queueEvent (Runnable runnable)
	Submits a runnable task to Kanzi's task dispatcher.
void	registerLifecycle (Lifecycle lifecycle)
	Attaches KanziView to the given Lifecycle.
void	resumeNativeApplication ()
	Lifecycle handler for Lifecycle.Event.ON_RESUME events.
void	setOrientation (int orientation)
	Handler for device/display orientation changes.
void	startNativeApplication ()
	Lifecycle handler for Lifecycle.Event.ON_START events.
void	stopNativeApplication ()
	Lifecycle handler for Lifecycle.Event.ON_STOP events.
void	surfaceChanged (SurfaceHolder holder, int format, int width, int height)
	This is called immediately after any structural changes (format or size) have been made to the surface.
void	surfaceCreated (SurfaceHolder holder)
	This is called immediately after the surface is first created.
void	surfaceDestroyed (SurfaceHolder holder)
	This is called immediately before a surface is being destroyed.

Protected Member Functions
boolean	isActiveView ()
	Checks is this instance the same which was passed to the native application by createNativeApplication().
void	onFocusChanged (boolean gainFocus, int direction, Rect previouslyFocusedRect)
	Called by the view system when the focus state of this KanziView changes.

Protected Attributes
State	mState = State.IDLE
	Current KanziView lifecycle state.
Surface	mSurface = null
	Valid Surface.

Detailed Description

A view that owns the native Kanzi application and provides the output surface.

Constructor & Destructor Documentation

KanziView() [1/2]

KanziView

(

Context

context

)

Simple constructor to use when creating a KanziView from code.

Parameters

context

The Context the KanziView is running in, through which it can access the current theme, resources, etc.

KanziView() [2/2]

KanziView	(	Context	context,
		AttributeSet	attrs )

Constructor that is called when inflating a KanziView from XML.

Parameters

context	The Context the KanziView is running in, through which it can access the current theme, resources, etc.
attrs	The attributes of the XML tag that is inflating the KanziView.

Member Function Documentation

createNativeApplication()

void createNativeApplication

(

)

Lifecycle handler for Lifecycle.Event.ON_CREATE events.

Loads the native library providing all Kanzi functionality. Initializes the context and assigns this KanziView for rendering. Creates Kanzi application which loads the Kanzi project.

destroyNativeApplication()

void destroyNativeApplication

(

)

Lifecycle handler for Lifecycle.Event.ON_DESTROY events.

Halts and destroys the Kanzi application.

isActiveView()

boolean isActiveView ( )

protected

Checks is this instance the same which was passed to the native application by createNativeApplication().

Returns

True if they are the same.

onFocusChanged()

void onFocusChanged ( boolean gainFocus, int direction, Rect previouslyFocusedRect )

protected

Called by the view system when the focus state of this KanziView changes.

Parameters

gainFocus	True if the KanziView has focus; false otherwise.
direction	The direction focus has moved when requestFocus() is called to give this KanziView focus.
previouslyFocusedRect	The rectangle, in this KanziView's coordinate system, of the previously focused view. May be null.

See also

android.view.View::View(Context context, AttributeSet attrs)

onKeyDown()

boolean onKeyDown	(	final int	keyCode,
		KeyEvent	event )

A key down handler.

Passes the key down event to the key event handler.

Parameters

keyCode	A key code that represents the button pressed, from android.view.KeyEvent.
event	The KeyEvent object that defines the button action.

Returns

If the event was handled by the superclass' handler, return true.

onKeyUp()

boolean onKeyUp	(	final int	keyCode,
		KeyEvent	event )

A key up handler.

Passes the key up event to the key event handler.

Parameters

keyCode	A key code that represents the button pressed, from android.view.KeyEvent.
event	The KeyEvent object that defines the button action.

Returns

If the event was handled by the superclass' handler, return true.

onTouchEvent()

boolean onTouchEvent

(

final MotionEvent

event

)

Handler for touches inside KanziView.

Translates the received events into the native library's touch states.

Parameters

event

The motion event.

Returns

True, always as this is the only touch handler for KanziView.

pauseNativeApplication()

void pauseNativeApplication

(

)

Lifecycle handler for Lifecycle.Event.ON_PAUSE events.

Logs the event.

queueEvent()

int queueEvent

(

Runnable

runnable

)

Submits a runnable task to Kanzi's task dispatcher.

This function fails if the task dispatcher is not yet initialized.

Parameters

runnable

The task to be run.

Returns

Zero on success, non-zero on failure.

registerLifecycle()

void registerLifecycle

(

Lifecycle

lifecycle

)

Attaches KanziView to the given Lifecycle.

Parameters

lifecycle

The lifecycle to attach to.

resumeNativeApplication()

void resumeNativeApplication

(

)

Lifecycle handler for Lifecycle.Event.ON_RESUME events.

Logs the event.

setOrientation()

void setOrientation

(

int

orientation

)

Handler for device/display orientation changes.

Translates the received orientation qualifiers into the native library's orientation constants.

Parameters

orientation

The orientation qualifier from onOrientationChanged().

startNativeApplication()

void startNativeApplication

(

)

Lifecycle handler for Lifecycle.Event.ON_START events.

Runs the Kanzi application if a surface has already been received.

stopNativeApplication()

void stopNativeApplication

(

)

Lifecycle handler for Lifecycle.Event.ON_STOP events.

Stops the Kanzi application.

surfaceChanged()

void surfaceChanged	(	SurfaceHolder	holder,
		int	format,
		int	width,
		int	height )

This is called immediately after any structural changes (format or size) have been made to the surface.

This method is always called at least once, after com.rightware.kanzi.KanziView#surfaceCreated.

Parameters

holder	The SurfaceHolder whose surface has changed.
format	The new PixelFormat of the surface.
width	The new width of the surface.
height	The new height of the surface.

surfaceCreated()

void surfaceCreated

(

SurfaceHolder

holder

)

This is called immediately after the surface is first created.

Passes the created surface to the native library for rendering target.

Parameters

holder

The SurfaceHolder whose surface is being created.

surfaceDestroyed()

void surfaceDestroyed

(

SurfaceHolder

holder

)

This is called immediately before a surface is being destroyed.

Parameters

holder

The SurfaceHolder whose surface is being destroyed.

Member Data Documentation

mSurface

Surface mSurface = null

protected

Valid Surface.

The surface will be captured during the onSurfaceCreated event.